-
Notifications
You must be signed in to change notification settings - Fork 88
Initial stab at mode documentation #3955
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
goldfirere
approved these changes
May 15, 2025
This is ready to merge, but let's wait until ccasin#3 is merged into it before hitting the button. |
cuihtlauac
reviewed
May 21, 2025
cuihtlauac
reviewed
May 22, 2025
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
modes
Work on modes. There's some overlap with the `multicore` label, but not strictly so.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some high-level documentation for our modes. The idea is to have a page that gives a brief overview of the whole suite of modes, without getting too far into the details of any one of them (for which it refers to the documentation about that particular feature).
I haven't attempted to write docs about the following axes: statefulness, visibility, yielding. Either someone else can write those and push them here, or they can be added in a future PR.